package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.VxCheckFaceAddDTO;
import org.jsola.hr.dto.VxCheckFaceUpdateDTO;
import org.jsola.hr.query.VxCheckFaceQuery;
import org.jsola.hr.vo.VxCheckFaceListVO;
import org.jsola.hr.vo.VxCheckFaceVO;

import java.util.List;

/**
 * 微信人脸核身
 *
 * @author zhr
 */
@Api(tags = "hr-微信人脸核身")
public interface IVxCheckFaceControllerAPI {

    /**
     * 新增微信人脸核身
     * @param vxCheckFaceAddDTO 微信人脸核身新增实体
     * @return 微信人脸核身展示对象
     */
    @ApiOperation(value = "新增微信人脸核身")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "vxCheckFaceAddDTO", dataType = "VxCheckFaceAddDTO", value = "新增微信人脸核身", paramType = "body")
    })
    Result<VxCheckFaceVO> save(VxCheckFaceAddDTO vxCheckFaceAddDTO);


    /**
     * 修改微信人脸核身
     * @param vxCheckFaceUpdateDTO 微信人脸核身
     * @return 更新数量
     */
    @ApiOperation(value = "修改微信人脸核身")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "vxCheckFaceUpdateDTO", dataType = "VxCheckFaceUpdateDTO", value = "修改微信人脸核身", paramType = "body")
    })
    Result<Integer> update(VxCheckFaceUpdateDTO vxCheckFaceUpdateDTO);




    /**
     * 删除单个微信人脸核身，彻底删除
     * @param vxCheckFaceId 微信人脸核身id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个微信人脸核身，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "vxCheckFaceId", dataType = "String", value = "微信人脸核身id", paramType = "path")
    })
    Result<Integer> delete(String vxCheckFaceId);


    /**
     * 批量删除微信人脸核身，彻底删除
     * @param vxCheckFaceIds 微信人脸核身id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除微信人脸核身，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "vxCheckFaceIds", dataType = "String[]", value = "微信人脸核身id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] vxCheckFaceIds);


    /**
     * 根据微信人脸核身id查询微信人脸核身详情
     * @param vxCheckFaceId 微信人脸核身id
     * @return 微信人脸核身详情
     */
    @ApiOperation(value="根据微信人脸核身id查询微信人脸核身详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "vxCheckFaceId", dataType = "String", value = "微信人脸核身id", paramType = "path")
    })
    Result<VxCheckFaceVO> findById(String vxCheckFaceId);


    /**
     * 查询微信人脸核身
     * @param vxCheckFaceQuery 微信人脸核身查询参数
     * @return page
     */
    @ApiOperation(value="查询微信人脸核身")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "vxCheckFaceQuery", dataType = "VxCheckFaceQuery", value = "微信人脸核身查询参数", paramType = "query")
    })
    Result<List<VxCheckFaceListVO>> listAll(VxCheckFaceQuery vxCheckFaceQuery);


     /**
     * 分页查询微信人脸核身
     * @param vxCheckFaceQuery 微信人脸核身查询参数
     * @return page
     */
    @ApiOperation(value="分页查询微信人脸核身")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "vxCheckFaceQuery", dataType = "VxCheckFaceQuery", value = "微信人脸核身查询参数", paramType = "query")
    })
    Result<Page<VxCheckFaceListVO>> page(VxCheckFaceQuery vxCheckFaceQuery);

    /**
     * 发起微信人脸核身预下单 及 授权
     * @param vxCheckFaceAddDTO 微信人脸核身新增实体
     * @return 微信人脸核身详情信息
     */
    @ApiOperation(value = "发起微信人脸核身预下单 及 授权")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "vxCheckFaceAddDTO", dataType = "VxCheckFaceAddDTO", value = "新增微信人脸核身", paramType = "body")
    })
    Result<VxCheckFaceVO> startCheckFace(VxCheckFaceAddDTO vxCheckFaceAddDTO);

    /**
     * 根据用工单位id 发起微信人脸核身预下单 及 授权
     * @param companyId 用工单位id
     * @return 微信人脸核身详情信息
     */
    @ApiOperation(value = "根据用工单位id 发起微信人脸核身预下单 及 授权")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyId", dataType = "String", value = "用工单位id", paramType = "path")
    })
    Result<VxCheckFaceVO> startCheckFaceByCompanyId(String companyId);



}

